home *** CD-ROM | disk | FTP | other *** search
/ MacHack 1993 / MacHack 1993.toast / MacHack™ 1987-1992 / MacHack™ '90 / Source Code ƒ / TLC&TLP1.01aƒ / tlpHelp.Doc < prev    next >
Encoding:
Text File  |  1990-01-28  |  5.5 KB  |  102 lines  |  [TEXT/MPS ]
  1. TLP v1.01 Release    * HELP *    Eduard Schwan Programs [ESP]
  2.  
  3. The Last Pascal Cross-referencer (TLP) is a Pascal language cross-referencer
  4. that reads one or more source files, and generates a source file listing (with
  5. line numbers) and a cross-reference list for the non-reserved symbols in
  6. the file(s).
  7. ------------------------------------------------------------------------------
  8. The reserved symbols are read from a text file (TLPresw.dat) during
  9. TLP initialization.  This file should contain only identifiers separated
  10. by spaces or newlines.    Pascal-style comments are also allowed.  Any symbols
  11. put in this file will be treated as reserved words, and will not be cross-
  12. referenced;  And, if any symbols are removed (or commented out) from this
  13. file, they will be cross-referenced.  This allows tracking down the usage
  14. of certain reserved words (like longint or fillchar, etc.)
  15. ------------------------------------------------------------------------------
  16. TLP usually gets the list of source files from the command line.  Sometimes,
  17. however, the list is quite long.  So TLP may be instructed to read a text
  18. file containing filenames (using the "-f filename" option).  This file must
  19. have one filename per line, with no leading or trailing blanks.  Blank lines
  20. and lines that begin with an asterisk ('*') in column 1 are ignored.
  21. ------------------------------------------------------------------------------
  22. TLP can be given additional instructions to tailor its operation and output
  23. by putting instructions into a 'parameter file'.  This is a text file, with
  24. parameter assignment statements in it.    The format is:
  25.     PARMNAME = numeric_value
  26.         or
  27.     PARMNAME = "String_Value"
  28. There may be multiple statements per line, but any one statement must be
  29. fully contained on one line.  String values may have C-style embedded escape
  30. sequences in them.    An example of a valid string follows:
  31.     Printer_init = "\033N\x1b?" /* "<ESC>N<ESC>?" */
  32. Parameter names are case-insensitive, and any underscores may be omitted
  33. (e.g. "PRINTER_INIT" and "PrinterInit" are treated as the same.)
  34. The list of parameter names and their range of values is:
  35.  
  36. Parameter Name        Valid Range        Description
  37. --------------        ------------    ---------------------------------------
  38. DO_INCLUDES         0..1 num        1=Read includes in-line, 0=ignore includes
  39. DO_LISTING            0..1 num        1=Output the source listing, 0=Don't
  40. DO_XREF             0..1 num        1=Output the crossref listing, 0=Don't
  41. DO_STATS            0..1 num        1=Output the statistics listing, 0=Don't
  42. OUT_FNAME            1..40 string    Send output to this filename (default:TLP.out)
  43.  
  44. PAGE_LINES            10..255 num        total # of lines per page
  45. PAGE_COLUMNS        10..255 num        # of characters per line between <CR>s
  46. TOP_LINE            1..10 num        first line # of page to begin printing on
  47. BOT_LINE            10..255 num        last valid line # of page to print on
  48. LEFT_COLUMN         1..40 num        leftmost column to begin printing in (indent)
  49. RIGHT_COLUMN        10..255 num        rightmost valid column to print in
  50. USER_HEADING        1..80 string    user-defined heading used as 2nd heading line
  51. DO_SINGLE_SHTS*        0..1 num        1=Pause between pages, 0=continuous paper
  52. PRINTER_INIT        1..80 string    string to send to printer once to init. it
  53. HAS_FORM_FEED        0..1 num        1=send <FF> at end of page, 0=send n <CR><LF>s
  54. FIRST_PAGE            1..9999 num        1st page of listing/xref (starting page #)
  55. LAST_PAGE            1..9999 num        last page of listing/xref (ending page #)
  56.  
  57. EMPH1_LEADIN        1..9 string        string to send printer to start emph1
  58. EMPH2_LEADIN        1..9 string        string to send printer to start emph2
  59. EMPH3_LEADIN        1..9 string        string to send printer to start emph3
  60. EMPH1_LEADOUT        1..9 string        string to send printer to stop emph1
  61. EMPH2_LEADOUT        1..9 string        string to send printer to stop emph2
  62. EMPH3_LEADOUT        1..9 string        string to send printer to stop emph3
  63.  
  64. TAB_WIDTH            0..16 num        width of tabstops
  65. EMPH_COMMENTS*        0..3 num        Emphasize comments in source listing
  66. EMPH_HEADING*        0..3 num        Emphasize the page headings
  67. EMPH_RESERVED*        0..3 num        Emphasize reserved words in source listing
  68. EMPH_FUNCHEADS*        0..3 num        Emphasize func. headings in source listing
  69. PAGING_STRING        1..15 string    do new list page when this string encountered
  70.  
  71. SYMBOL_SIZE         1..32 num        # of significant characters in identifiers
  72. XREF_NUMS            0..1 num        Cross-reference and list all numbers
  73. XREF_STRINGS        0..1 num        Cross-reference and list all strings/chars
  74. DO_CONDITIONALS*     0..1 num        1=Evaluate & skip cond. code (#ifdef), 0=All
  75. DO_CASE_SENS        0..1 num        1=Make symbols case significant, 0=not sig.
  76. DO_XCASE_SENS*        0..1 num        1=Sort xref list case significant, 0=not sig.
  77. DO_UNDERSCORES        0..1 num        1=Make underscores significant, 0=Delete
  78. EMPH_SYMBOLS        0..3 num        Emphasize symbols in cross-reference list
  79.  
  80.     * = Not Implemented Yet
  81. ------------------------------------------------------------------------------
  82. To run The Last Cross-referencer, use the following command (parameters in
  83. square brackets [] are optional:
  84.  
  85. TLP [-f FnameListFile] [-p ParmFile] [-r ResWordFile] [-v] [-d] FileNames..
  86.  
  87. Where:
  88.     -d                    ........Turns on debug messages sent to stderr.
  89.     -f FnameListFile    ........Optional file containing list of source
  90.                                 file names to cross-reference.
  91.     -p ParmFile            ........File containing parameters for
  92.                                 tailoring TLP output. (def.=TLPParm.Dat)
  93.     -r ResWordFile        ........File containing reserved words
  94.                                 not to be cross-referenced.  (def.=TLPResw.Dat)
  95.     -v                    ........Turns on progress messages sent to stderr.
  96.                                 Repeating this option (-v -v) gives even
  97.                                 more info.
  98.     FileName(s)            ........Source files to be cross-referenced.
  99.  
  100. Example:
  101.     TLP  -v  -r  myresw.dat  file1.inc  file2.inc  file1.pas  file2.pas
  102.